home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2000 #4 / Amiga Plus CD - 2000 - No. 4.iso / Tools / Dev / Bgui / AutoDoc / vectorclass.doc < prev    next >
Encoding:
Text File  |  2000-05-09  |  4.1 KB  |  190 lines
  1. TABLE OF CONTENTS
  2.  
  3. vectorclass/--background--
  4. vectorclass/VIT_BuiltIn
  5. vectorclass/VIT_DriPen
  6. vectorclass/VIT_Pen
  7. vectorclass/VIT_VectorArray
  8.  
  9. vectorclass/--background--
  10.  
  11. NAME
  12.  
  13.   Class:      vectorclass
  14.   Superclass: IMAGECLASS
  15.   Include File: <libraries/bgui.h>
  16.  
  17. FUNCTION
  18.  
  19.   To provide you with an easy way to create simple, fully scalable
  20.   images. The image consists of an array of small structures which
  21.   contains coordinates and command flags.
  22.  
  23. vectorclass/VIT_BuiltIn
  24.  
  25. NAME
  26.  
  27.   VIT_BuiltIn -- ( ULONG )
  28.  
  29. FUNCTION
  30.  
  31.   Set or get any of the built-in images. You can select any of the
  32.   following images:
  33.  
  34.   BUILTIN_GETPATH -- Also known as a folder image. This image is usually
  35.     used in a button which pops up a filerequester to select a drawer.
  36.  
  37.   BUILTIN_GETFILE -- This image is usually used in a button which pops
  38.     up a filerequester to select a file.
  39.  
  40.   BUILTIN_CHECKMARK -- Standard, fully scalable, checkmark/checkbox
  41.     image.
  42.  
  43.   BUILTIN_POPUP -- This image is usually used in a button which pops up
  44.     a requester to select some sort of data like screen mode, fonts etc.
  45.  
  46.   BUILTIN_ARROW_UP -- An up arrow image.
  47.  
  48.   BUILTIN_ARROW_DOWN -- A down arrow image.
  49.  
  50.   BUILTIN_ARROW_LEFT -- A left arrow image.
  51.  
  52.   BUILTIN_ARROW_RIGHT -- A right arrow image.
  53.  
  54. DEFAULT
  55.  
  56.   0 (none).
  57.  
  58. APPLICABILITY
  59.  
  60.   (ISG).
  61.  
  62. vectorclass/VIT_DriPen
  63.  
  64. NAME
  65.  
  66.   VIT_DriPen -- ( UWORD )
  67.  
  68. FUNCTION
  69.  
  70.   Set or get the drawinfo pen used to render the image.
  71.  
  72. DEFAULT
  73.  
  74.   ~0.
  75.  
  76. APPLICABILITY
  77.  
  78.   (ISG).
  79.  
  80. SEE ALSO
  81.  
  82.   <intuition/screens.h>, VIT_Pen
  83.  
  84. vectorclass/VIT_Pen
  85.  
  86. NAME
  87.  
  88.   VIT_Pen -- ( UWORD )
  89.  
  90. FUNCTION
  91.  
  92.   Set or get the pen which is used to render the image.
  93.  
  94. DEFAULT
  95.  
  96.   ~0.
  97.  
  98. APPLICABILITY
  99.  
  100.   (ISG).
  101.  
  102. SEE ALSO
  103.  
  104.   VIT_DriPen
  105.  
  106. vectorclass/VIT_VectorArray
  107.  
  108. NAME
  109.  
  110.   VIT_VectorArray -- ( struct VectorItem * )
  111.  
  112. FUNCTION
  113.  
  114.   Set or get a pointer to an array of VectorItem structures. The
  115.   VectorItem structure is a small structure which contains information
  116.   on the coordinates and command flags.
  117.  
  118.   struct VectorItem {
  119.     WORD  vi_x;
  120.     WORD  vi_y;
  121.     ULONG vi_Flags;
  122.   };
  123.  
  124.   vi_x -- This field contains either the x-coordinate of the next point
  125.     or other data depending which command flags are set in the
  126.     vi_Flags field.
  127.  
  128.   vi_y -- This field contains either the y-coordinate of the next point
  129.     or other data depending which command flags are set in the
  130.     vi_Flags field.
  131.  
  132.   vi_Flags -- This field can contain any of the following flags:
  133.  
  134.     VIF_MOVE -- Move to the location described in vi_x and vi_y.
  135.  
  136.     VIF_DRAW -- Draw to the location described in vi_x and vi_y.
  137.  
  138.     VIF AREASTART -- Start area-filling at the location described
  139.       in vi_x, vi_y. All VIF_MOVE and VIF_DRAW commands will now
  140.       AreaMove() and AreaDraw().
  141.  
  142.     VIF_AREAEND -- End area-filling at the location described in
  143.       vi_x, vi_y. All VIF_MOVE and VIF_DRAW commands will now
  144.       Move() and Draw().
  145.  
  146.     VIF_XRELRIGHT -- vi_x is relative to the right image border.
  147.  
  148.     VIF_YRELBOTTOM -- vi_yis relative to the bottom image border.
  149.  
  150.     VIF_SHADOWPEN -- Set the SHADOWPEN and move/draw.
  151.  
  152.     VIF_SHINEPEN -- Set the SHINEPEN and move/draw.
  153.  
  154.     VIF_FILLPEN -- Set the FILLPEN and move/draw.
  155.  
  156.     VIF_TEXTPEN -- Set the TEXTPEN and move/draw.
  157.  
  158.     VIF_COLOR -- Set the pen described in vi_x. No move/draw.
  159.  
  160.     VIF_LASTITEM -- This flag terminates the VectorItem array.
  161.       This flag _must_ be set in the last VectorItem of the
  162.       array as it's the only way for the class to know when
  163.       it has reached the end.
  164.  
  165.     VIF_SCALE -- vi_x and vi_y contain the design size of the
  166.       image. The design size usually is the size of the image
  167.       when using a 8x8 font.  Without this information the image
  168.       cannot and will not scale.
  169.  
  170.     VIF_DRIPEN -- Set the drawinfo pen described in vi_x. No move/
  171.       draw. See <intuition/screens.h> about drawinfo pens.
  172.  
  173.     VIF_AOLPEN -- Set the area-outline pen to the pen described in
  174.       vi_x. No move/draw.
  175.  
  176.     VIF_AOLDRIPEN -- Set the area-outline pen to the drawinfo pen
  177.       described in vi_x. No move/draw. See <intuition/screens.h>
  178.       about drawinfo pens.
  179.  
  180.     VIF_ENDOPEN -- Terminate the area-outline mode.
  181.  
  182. DEFAULT
  183.  
  184.   NULL.
  185.  
  186. APPLICABILITY
  187.  
  188.   (ISG).
  189.  
  190.